Azure Maps Spatial Service (preview:1.0)

2025/08/14 • 9 deleted methods

Spatial_GetGeofence (removed)
Description :  **Search Geofence Get API** **Applies to:** S1 Pricing tier. The Geofence Get API allows you to retrieve the proximity of a coordinate to a geofence that has been uploaded to the Data service. You can use the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) to upload a geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) for more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well as the ID for the fence or set of fences, and the response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.

This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects. The API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default). To test this API, you can upload the sample data from Post Geofence API examples (Request Body) via Data Upload API and replace the `{udid}` from the sample request below with the udid returned by Data Upload API. ### Geofencing InnerError code In geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`. innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | Device Id should not be null. NullUdid | Udid should not be null. UdidWrongFormat| Udid should be acquired from user data ingestion API. InvalidUserTime| Usertime is invalid. InvalidSearchBuffer| Searchbuffer is invalid. InvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters. InvalidLatLon| Lat and/or lon parameters are invalid. InvalidIsAsyncValue| The IsAsync parameter is invalid. InvalidModeValue| The mode parameter invalid. InvalidJson| Geofencing data is not a valid json file. NotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections. InvalidGeoJson| Geofencing data is invalid. NoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id. NoUserDataWithUdid| Can't find user geofencing data with provided udId.
Reference :  Link ¶

⚼ Request

GET:  /spatial/geofence/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
deviceId:
{
Description: ID of the device ,
Required: True ,
}
string ,
udId:
{
Description: The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: True ,
}
string ,
lat:
{
Description: The latitude of the location being passed. Example: 48.36. ,
Required: True ,
}
number ,
lon:
{
Description: The longitude of the location being passed. Example: -124.63. ,
Required: True ,
}
number ,
z:
{
Description: The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion is used. Example: 200. ,
Required: False ,
}
number ,
userTime:
{
Description: The user request time. If not presented in the request, the default value is DateTime.Now. ,
Required: False ,
}
string ,
searchBuffer:
{
Description: The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50. ,
Required: False ,
}
number ,
isAsync:
{
Description: If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false. ,
Required: False ,
}
boolean ,
mode:
{
Description: Mode of the geofencing async event mechanism. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-correlation-id:
{
Description: Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event. ,
}
string ,
}
,
$schema:
{
Description: This object is returned from a geofence proximity call. ,
}
{
geometries:
{
Description: Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position. ,
Required: False ,
}
[
{
deviceId:
{
Description: ID of the device. ,
Required: False ,
}
string ,
udId:
{
Description: The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: False ,
}
string ,
geometryId:
{
Description: The unique id identifies a geometry. ,
Required: False ,
}
string ,
distance:
{
Description: Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence. ,
Required: False ,
}
number ,
nearestLat:
{
Description: Latitude of the nearest point of the geometry. ,
Required: False ,
}
number ,
nearestLon:
{
Description: Longitude of the nearest point of the geometry. ,
Required: False ,
}
number ,
nearestZ:
{
Description: Sea level in meter of the nearest point on the 2D extrusion geometry. This will only be presented in response when value is provided for 'zInMeter' in the request. ,
Required: False ,
}
number ,
}
,
]
,
expiredGeofenceGeometryId:
{
Description: Lists of the geometry ID of the geofence which is expired relative to the user time in the request. ,
Required: False ,
}
[
string ,
]
,
invalidPeriodGeofenceGeometryId:
{
Description: Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request. ,
Required: False ,
}
[
string ,
]
,
isEventPublished:
{
Description: True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber. This will only be presented in response when 'isAsync' query parameter is set to true. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_PostGeofence (removed)
Description :  **Search Geofence Post API** **Applies to:** S1 Pricing tier. The Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.

This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects. The API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).
Reference :  Link ¶

⚼ Request

POST:  /spatial/geofence/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
deviceId:
{
Description: ID of the device ,
Required: True ,
}
string ,
lat:
{
Description: The latitude of the location being passed. Example: 48.36. ,
Required: True ,
}
number ,
lon:
{
Description: The longitude of the location being passed. Example: -124.63. ,
Required: True ,
}
number ,
z:
{
Description: The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion geofencing is applied. Example: 200. ,
Required: False ,
}
number ,
userTime:
{
Description: The user request time. If not presented in the request, the default value is DateTime.UtcNow. ,
Required: False ,
}
string ,
searchBuffer:
{
Description: The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50. ,
Required: False ,
}
number ,
isAsync:
{
Description: If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false. ,
Required: False ,
}
boolean ,
mode:
{
Description: Mode of the geofencing async event mechanism. ,
Required: False ,
}
string ,
searchGeofenceRequestBody:
{
Description: The geofencing GeoJSON data. ,
Required: True ,
}
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "FeatureCollection". ,
Required: True ,
}
string ,
features:
{
Description: Contains a list of valid `GeoJSON Feature` objects. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "Feature". ,
Required: False ,
}
string ,
geometry:
{
Description: A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. ,
Enum:
{
Point: `GeoJSON Point` geometry. ,
MultiPoint: `GeoJSON MultiPoint` geometry. ,
LineString: `GeoJSON LineString` geometry. ,
MultiLineString: `GeoJSON MultiLineString` geometry. ,
Polygon: `GeoJSON Polygon` geometry. ,
MultiPolygon: `GeoJSON MultiPolygon` geometry. ,
GeometryCollection: `GeoJSON GeometryCollection` geometry. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-correlation-id:
{
Description: Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event. ,
}
string ,
}
,
$schema:
{
Description: This object is returned from a geofence proximity call. ,
}
{
geometries:
{
Description: Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position. ,
Required: False ,
}
[
{
deviceId:
{
Description: ID of the device. ,
Required: False ,
}
string ,
udId:
{
Description: The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: False ,
}
string ,
geometryId:
{
Description: The unique id identifies a geometry. ,
Required: False ,
}
string ,
distance:
{
Description: Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence. ,
Required: False ,
}
number ,
nearestLat:
{
Description: Latitude of the nearest point of the geometry. ,
Required: False ,
}
number ,
nearestLon:
{
Description: Longitude of the nearest point of the geometry. ,
Required: False ,
}
number ,
nearestZ:
{
Description: Sea level in meter of the nearest point on the 2D extrusion geometry. This will only be presented in response when value is provided for 'zInMeter' in the request. ,
Required: False ,
}
number ,
}
,
]
,
expiredGeofenceGeometryId:
{
Description: Lists of the geometry ID of the geofence which is expired relative to the user time in the request. ,
Required: False ,
}
[
string ,
]
,
invalidPeriodGeofenceGeometryId:
{
Description: Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request. ,
Required: False ,
}
[
string ,
]
,
isEventPublished:
{
Description: True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber. This will only be presented in response when 'isAsync' query parameter is set to true. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_PostBuffer (removed)
Description :  **Applies to**: S1 pricing tier. This API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.
Reference :  Link ¶

⚼ Request

POST:  /spatial/buffer/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
bufferRequestBody:
{
Description: The FeatureCollection and the list of distances (one per feature or one for all features). ,
Required: True ,
}
{
geometries:
{
Description: A valid `GeoJSON FeatureCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "FeatureCollection". ,
Required: True ,
}
string ,
features:
{
Description: Contains a list of valid `GeoJSON Feature` objects. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "Feature". ,
Required: False ,
}
string ,
geometry:
{
Description: A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. ,
Enum:
{
Point: `GeoJSON Point` geometry. ,
MultiPoint: `GeoJSON MultiPoint` geometry. ,
LineString: `GeoJSON LineString` geometry. ,
MultiLineString: `GeoJSON MultiLineString` geometry. ,
Polygon: `GeoJSON Polygon` geometry. ,
MultiPolygon: `GeoJSON MultiPolygon` geometry. ,
GeometryCollection: `GeoJSON GeometryCollection` geometry. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value ,
Required: False ,
}
object ,
}
,
]
,
}
,
distances:
{
Description: List of the distances to compute the buffer for, one-to-one per Feature in the collection, or one for all Features in the collection. ,
Required: False ,
}
[
number ,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary of the call. ,
Required: False ,
}
{
udid:
{
Description: The udid for the user data if one exists ,
Required: False ,
}
string ,
information:
{
Description: The information about what happened during the call. ,
Required: False ,
}
string ,
}
,
result:
{
Description: The FeatureCollection of buffers for the input. ,
Required: False ,
}
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "FeatureCollection". ,
Required: True ,
}
string ,
features:
{
Description: Contains a list of valid `GeoJSON Feature` objects. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "Feature". ,
Required: False ,
}
string ,
geometry:
{
Description: A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. ,
Enum:
{
Point: `GeoJSON Point` geometry. ,
MultiPoint: `GeoJSON MultiPoint` geometry. ,
LineString: `GeoJSON LineString` geometry. ,
MultiLineString: `GeoJSON MultiLineString` geometry. ,
Polygon: `GeoJSON Polygon` geometry. ,
MultiPolygon: `GeoJSON MultiPolygon` geometry. ,
GeometryCollection: `GeoJSON GeometryCollection` geometry. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_GetBuffer (removed)
Description :  **Applies to**: S1 pricing tier. This API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. To test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postbuffer#examples) examples (Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.
Reference :  Link ¶

⚼ Request

GET:  /spatial/buffer/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
udid:
{
Description: The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: True ,
}
string ,
distances:
{
Description: The list of distances (one per feature or one for all features), delimited by semicolons. For example, 12.34;-56.78. Positive distance will generate a buffer outside of the feature, whereas negative distance will generate a buffer inside of the feature. If the negative distance larger than the geometry itself, an empty polygon will be returned. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary of the call. ,
Required: False ,
}
{
udid:
{
Description: The udid for the user data if one exists ,
Required: False ,
}
string ,
information:
{
Description: The information about what happened during the call. ,
Required: False ,
}
string ,
}
,
result:
{
Description: The FeatureCollection of buffers for the input. ,
Required: False ,
}
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "FeatureCollection". ,
Required: True ,
}
string ,
features:
{
Description: Contains a list of valid `GeoJSON Feature` objects. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "Feature". ,
Required: False ,
}
string ,
geometry:
{
Description: A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. ,
Enum:
{
Point: `GeoJSON Point` geometry. ,
MultiPoint: `GeoJSON MultiPoint` geometry. ,
LineString: `GeoJSON LineString` geometry. ,
MultiLineString: `GeoJSON MultiLineString` geometry. ,
Polygon: `GeoJSON Polygon` geometry. ,
MultiPolygon: `GeoJSON MultiPolygon` geometry. ,
GeometryCollection: `GeoJSON GeometryCollection` geometry. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_PostClosestPoint (removed)
Description :  **Applies to**: S1 pricing tier. This API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.
Reference :  Link ¶

⚼ Request

POST:  /spatial/closestPoint/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
lat:
{
Description: The base point latitude of the location being passed. Example: 47.622942. ,
Required: True ,
}
number ,
lon:
{
Description: The base point longitude of the location being passed. Example: -122.316456. ,
Required: True ,
}
number ,
numberOfClosestPoints:
{
Description: The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50 ,
Required: False ,
}
integer ,
closestPointRequestBody:
{
Description: The FeatureCollection of Point geometries from which closest point to source point should be determined. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: True ,
}
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "FeatureCollection". ,
Required: True ,
}
string ,
features:
{
Description: Contains a list of valid `GeoJSON Feature` objects. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "Feature". ,
Required: False ,
}
string ,
geometry:
{
Description: A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. ,
Enum:
{
Point: `GeoJSON Point` geometry. ,
MultiPoint: `GeoJSON MultiPoint` geometry. ,
LineString: `GeoJSON LineString` geometry. ,
MultiLineString: `GeoJSON MultiLineString` geometry. ,
Polygon: `GeoJSON Polygon` geometry. ,
MultiPolygon: `GeoJSON MultiPolygon` geometry. ,
GeometryCollection: `GeoJSON GeometryCollection` geometry. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Post Closest Point Summary object ,
Required: False ,
}
{
sourcePoint:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
udid:
{
Description: A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null) ,
Required: False ,
}
string ,
information:
{
Description: Processing information ,
Required: False ,
}
string ,
}
,
result:
{
Description: Closest Point Result Array ,
Required: False ,
}
[
{
distanceInMeters:
{
Description: The distance in meters from the source point to the closest point ,
Required: False ,
}
number ,
position:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
geometryId:
{
Description: The unique id identifies a geometry ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_GetClosestPoint (removed)
Description :  **Applies to**: S1 pricing tier. This API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point. To test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postclosestpoint#examples) examples (Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.
Reference :  Link ¶

⚼ Request

GET:  /spatial/closestPoint/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
udid:
{
Description: The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: True ,
}
string ,
lat:
{
Description: The base point latitude of the location being passed. Example: 47.622942. ,
Required: True ,
}
number ,
lon:
{
Description: The base point longitude of the location being passed. Example: -122.316456. ,
Required: True ,
}
number ,
numberOfClosestPoints:
{
Description: The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
summary:
{
Description: Get Closest Point Summary object ,
Required: False ,
}
{
sourcePoint:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
udid:
{
Description: A unique data id (udid) for the uploaded content ,
Required: False ,
}
string ,
information:
{
Description: Processing information ,
Required: False ,
}
string ,
}
,
result:
{
Description: Closest Point Result Array ,
Required: False ,
}
[
{
distanceInMeters:
{
Description: The distance in meters from the source point to the closest point ,
Required: False ,
}
number ,
position:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
geometryId:
{
Description: The unique id identifies a geometry ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_PostPointInPolygon (removed)
Description :  **Applies to**: S1 pricing tier. This API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.
Reference :  Link ¶

⚼ Request

POST:  /spatial/pointInPolygon/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
lat:
{
Description: The base point latitude of the location being passed. Example: 47.622942. ,
Required: True ,
}
number ,
lon:
{
Description: The base point longitude of the location being passed. Example: -122.316456. ,
Required: True ,
}
number ,
pointInPolygonRequestBody:
{
Description: A FeatureCollection with a set of Polygon/MultiPolygon geometries. The maximum number of vertices accepted to form a Polygon is 10,000. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: True ,
}
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "FeatureCollection". ,
Required: True ,
}
string ,
features:
{
Description: Contains a list of valid `GeoJSON Feature` objects. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `type` for the object. Value should always be equal to "Feature". ,
Required: False ,
}
string ,
geometry:
{
Description: A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. ,
Enum:
{
Point: `GeoJSON Point` geometry. ,
MultiPoint: `GeoJSON MultiPoint` geometry. ,
LineString: `GeoJSON LineString` geometry. ,
MultiLineString: `GeoJSON MultiLineString` geometry. ,
Polygon: `GeoJSON Polygon` geometry. ,
MultiPolygon: `GeoJSON MultiPolygon` geometry. ,
GeometryCollection: `GeoJSON GeometryCollection` geometry. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Point In Polygon Summary object ,
Required: False ,
}
{
sourcePoint:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
udid:
{
Description: A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null) ,
Required: False ,
}
string ,
information:
{
Description: Processing information ,
Required: False ,
}
string ,
}
,
result:
{
Description: Point In Polygon Result Object ,
Required: False ,
}
{
pointInPolygons:
{
Description: Point In Polygons Property ,
Required: False ,
}
boolean ,
intersectingGeometries:
{
Description: Geometries array ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_GetPointInPolygon (removed)
Description :  **Applies to**: S1 pricing tier. This API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000. To test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postpointinpolygon#examples) examples (Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.
Reference :  Link ¶

⚼ Request

GET:  /spatial/pointInPolygon/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
udid:
{
Description: The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. ,
Required: True ,
}
string ,
lat:
{
Description: The base point latitude of the location being passed. Example: 47.622942. ,
Required: True ,
}
number ,
lon:
{
Description: The base point longitude of the location being passed. Example: -122.316456. ,
Required: True ,
}
number ,
}

⚐ Response (200)

{
summary:
{
Description: Point In Polygon Summary object ,
Required: False ,
}
{
sourcePoint:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
udid:
{
Description: A unique data id (udid) for the uploaded content ,
Required: False ,
}
string ,
information:
{
Description: Processing information ,
Required: False ,
}
string ,
}
,
result:
{
Description: Point In Polygon Result Object ,
Required: False ,
}
{
pointInPolygons:
{
Description: Point In Polygons Property ,
Required: False ,
}
boolean ,
intersectingGeometries:
{
Description: Geometries array ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Spatial_GetGreatCircleDistance (removed)
Description :  **Applies to**: S1 pricing tier. This API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.
Reference :  Link ¶

⚼ Request

GET:  /spatial/greatCircleDistance/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The Coordinates through which the distance is calculated, delimited by a colon. Two coordinates are required. The first one is the source point coordinate and the last is the target point coordinate. For example, 47.622942,122.316456:57.673988,127.121513 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object ,
Required: False ,
}
{
sourcePoint:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
targetPoint:
{
Description: A location represented as a latitude and longitude ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
result:
{
Description: Result Object ,
Required: False ,
}
{
distanceInMeters:
{
Description: The great circle distance in meters from the source point to the target point ,
Required: False ,
}
number ,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}